﻿Objective: 
==========
This ReadMe file contains the details of FT_App_Gauges application release package. 

This package contains the FT800 FT_App_Gauges application targeting Windows PC and Arduino platform.  

This application demonstrates interactive Gauges using Lines & custom Font based on FT800 platform.

Release package contents:
=========================
The folder structure is shown as below.


+---Bin
|   \---Msvc_win32
|              \--libMPSSE.a - MPSSE library file.
|              \--ftd2xx.dll - ftd2xx library file.
|
+---Hdr
|   \---\FT_CoPro_Cmds.h  - Includes the Coprocessor commands.
|   \---\FT_DataTypes.h - Includes the FT800 datatypes.
|   \---\FT_Gpu.h - Includes the GPU commands.
|   \---\FT_Gpu_Hal.h - Includes the GPU Hal commands.
|   \---\FT_Hal_Utils.h - Includes the HAL utilities.
|   \---\FT_Platform.h - Includes Platform specific macros.
|
|   \---Msvc_win32
|              \--ftd2xx.h - ftd2xx header file
|              \--libMPSSE_spi - MPSSE header file
|
+---Project
|   \---Arduino
|              \---FT_App_Gauges – project folder of FT_App_Gauges Demo application based on arduino IDE
|                              \---\FT_App_Gauges.ino – Sketch file of FT_App_Gauges Demo application
|                              \---\FT_CoPro_Cmds.cpp - Coprocessor commands source file.
|                              \---\FT_CoPro_Cmds.h  - Includes the Coprocessor commands.
|                              \---\FT_DataTypes.h - Includes the FT800 datatypes.
|                              \---\FT_Gpu.h - Includes the GPU commands.
|                              \---\FT_Gpu_Hal.cpp – GPU HAL source
|                              \---\FT_Gpu_Hal.h - Includes the GPU HAL commands.
|                              \---\FT_Hal_I2C.cpp - Includes I2c Source code
|                              \---\FT_Hal_I2C.h - Includes I2c APIs.
|                              \---\FT_Hal_Utils.h - Includes the hal utilities.
|                              \---\FT_Platform.h - Includes Platform specific commands.
|                              \---\sdcard.h - Includes sdcard source.
|
|   \---Msvc_win32
|       \---FT_App_Gauges – project folder of FT_App_Gauges Demo application based on MSVC/PC platform
|                              \---FT_App_Gauges.sln – solution file of FT_App_Gauges Demo application
|                              \---FT_App_Gauges.vcxproj – project file of FT_App_Gauges Demo application
|                              \---FT_App_Gauges.vcxproj.filters
|                              \---FT_App_Gauges.vcxproj.user
|
+---Src
|              \---FT_CoPro_Cmds.c - Coprocessor commands source file.
|              \---FT_Gpu_Hal.c - Gpu hal source commands file.
|              \---FT_App_Gauges.c - Main file of FT_App_Gauges dial.
|
+--Test – folder containing input test files such as .wav, .jpg, .raw etc


Configuration Instructions:
===========================
This section contains details regarding various configurations supported by this software.

Two display profiles are supported by this software: (1) WQVGA (480x272) (2) QVGA (320x240)
Two arduino platforms are supported by this software: (1) VM800P – FTDI specific module (2) Arduino pro

The above two configurations can be enabled/disabled via commenting/uncommenting macors in FT_Platform.h file. For MVSC/PC platform please look into .\FT_App_Gauges\Hdr\FT_Platform.h and for arduino platform please look into .\FT_App_Gauges\Project\Aurdino\FT_App_Gauges\FT_App_Gauges\FT_Platform.h

By default WQVGA display profile is enabled. To enable QVGA, uncomment “#define SAMAPP_DISPLAY_QVGA” macro in respective FT_Platform.h file.

For arduino platform please uncomment any one of the macros (1) “#define  FT_ATMEGA_328P” – FTDI specific module (2) “#define ARDUINO_PRO_328” – arduino pro. At any point of time only one macro should be uncommented/enabled.


Installation Instruction:
=========================

Unzip the package onto a respective project folder and open the solution/sketch file in the project folder and execute it. For MSVC/PC platform please execute .\FT_App_Gauges\Project\Msvc_win32\FT_App_Gauges\FT_App_Gauges.sln solution. For arduino platform please execute.\FT_App_Gauges\Project\Aurdino\FT_App_Gauges\FT_App_Gauges\FT_App_Gauges.ino sketch.

The MSVC project file is compatible with Microsoft visual C++ 2010 Express.
The arduino project file is compatible with Arduino 1.0.5.
For arduino platform copy the files under TEST folder to SD card.


Reference Information:
======================
Please refer to AN_263_FT_App_Gauges for more information on application design, setup etc.
Please refer to FT800_Programmer_Guide for more information on programming FT800.

Known issues:
=============
1. This application contains only SPI interface to FT800.
2. The SPI host(Arduino, Windows PC) are assuming the data layout in memory as Little Endian format. 
3. For Arduino based platform, this application utilizes the time information from RTC for FTDI specific module or inbuilt time apis for arduino pro modules. 

Extra Information:
==================
N.A


Release Notes (Version Significance):
=====================================
Version 1.0 - Final version based on the requirements.
Version 0.1 - intial draft of the release notes

